Repository navigation
Conversation
The articles read as numbered chapters in three parts, in the order of `articles:` in _pkgdown.yml (Get started is chapter 1). On an article page the right sidebar shows the chapters, with the current chapter's sections nested and numbered (5.1, 5.1.1) and the section in view highlighted; the other chapters' sections unfold on demand. The headings carry the same numbers, and each article ends with links to the previous and the next chapter. On a phone the panel is a collapsed box below the title. The articles index numbers its entries the same way. pkgdown/extra.js reads the chapters from the navbar that pkgdown builds from `articles:`, so a new article is one line in that list.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The articles are now read like a book: seven numbered chapters (Get started, then the six articles) in three parts.
sections are nested under it and numbered (5.1, 5.2, and 5.1.1 where an article has third-level headings); the
section in view is highlighted while scrolling. This panel replaces "On this page". The small arrow beside another
chapter unfolds that chapter's sections.
(with a one-line description).
The order comes from one place,
articles:in_pkgdown.yml.pkgdown/extra.jsreads the chapters from thenavbar that pkgdown builds from that list, so adding an article is one line in
contentsand the numbers after itmove up by themselves. The navbar is unchanged.
Only
_pkgdown.yml,pkgdown/extra.css, the newpkgdown/extra.jsand the YAML header of the Get started vignette(a
description) change;pkgdown/is already in.Rbuildignore. No package code changes.